home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 095 / tbbs105.arc / BBS105.DOC < prev    next >
Text File  |  1985-10-02  |  20KB  |  529 lines
  1.         Turbo BBS Version 1.05 - System Operator Notes - Page 1
  2.  
  3.  
  4.         1 - Features:
  5.  
  6.           - Self-contained Message and Files system written in Pascal;
  7.           - Program not operating system dependent;
  8.           - Information files editable with WordStar;
  9.           - Variable Terminal width with word-wrap;
  10.           - User profile (password, terminal parameters) kept on file;
  11.           - Real-time clock time stamping of files and messages;
  12.           - Private and public messages supported;
  13.           - Can be configured as a private BBS;
  14.           - Variable access levels available;
  15.           - File and message sub-sections for easier user access;
  16.           - All uploaded files stamped with name of contributor;
  17.           - Number of accesses of each file recorded;
  18.           - XMODEM protocol (CRC & checksum) fully supported;
  19.           - Calls logged with sign-on and sign-off times;
  20.           - Comments to System Operator (Sysop) file;
  21.           - Supports squeezed and library files;
  22.           - Directly drives serial port hardware.
  23.  
  24.         2 - System files:  The following files are included in the  Turbo 
  25.         BBS package:
  26.  
  27.         * Required to compile the program: BBS.PAS
  28.                                            BBS2.INC
  29.                                            IO.INC
  30.                                            MACHDEP.INC
  31.                                            MAILSYS.INC
  32.                                            FILESYS.INC
  33.  
  34.         The  above .PAS file must be on the logged drive,  and  the  .INC 
  35.         files on drive A: when compiling!
  36.         The BBS program should be compiled to a .COM file.
  37.  
  38.         * Required on the default drive to run the compiled BBS program:
  39.  
  40.           BBS.COM (obviously);
  41.  
  42.         *  The  following files are created automatically on the  default 
  43.         drive (space should be reserved for them).
  44.  
  45.           MESSAGES.BBS - the system message table:  contains records  for 
  46.         each message giving user numbers of sender and receiver, subject, 
  47.         time stamp,  message and section number, and whether the receiver 
  48.         has  read  the message or not.  This table is loaded into  a  RAM 
  49.         buffer  whenever the system is active (ie.  caller on-line),  and 
  50.         restored to disk at sign-off.
  51.  
  52.           FILES.BBS - the table of files available on-line. Each file has 
  53.         a record noting name,  size,  contributor, access count, section, 
  54.         and whether the file is private or public.
  55.  
  56.           LOG.BBS - Call Log,  holding Caller, time on and time off info, 
  57.         (providing the clock routines are enabled).
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.         Turbo BBS Version 1.05 - System Operator Notes - Page 2
  68.  
  69.  
  70.           COMMENTS.BBS - Contains comments to Sysop, includes caller name 
  71.         and  time stamp.  Comments are set to a 15 line maximum length by 
  72.         the  [G]oodbye  command,  and limited to 4 lines by  the  [A]pply 
  73.         command.
  74.  
  75.           IDS.BBS  - Contains registered user  names,  passwords,  access 
  76.         levels,  terminal  parameters,  last call date and  high  message 
  77.         number.
  78.  
  79.  
  80.         The  following text files containing on-line user information are 
  81.         expected in a library B:BBSINFO.LBR.
  82.  
  83.           WELCOME.TXT  - The pre-sign-on user welcome file.  Should  give 
  84.         details about the system's features, hours, and policies, as well 
  85.         as  any news about new system features.  Newest bulletins  should 
  86.         occur  first in a file so frequent users do not have to read long 
  87.         stretches of familiar information to get the new stuff. This file 
  88.         is also listed by the W (Welcome) command.
  89.  
  90.           BBSHELP.TXT  - The  on-line Help file,  containing  the  system 
  91.         commands and user hints. Also should list the subcommands for the 
  92.         commands that support them.  This file is listed by the H  (Help) 
  93.         command.
  94.  
  95.           BBSLIST.TXT - Contains a list of other remote access systems of 
  96.         interest. Listed by the O (Other systems) command.
  97.  
  98.           SYSINFO.TXT - Gives information about the equipment running the 
  99.         BBS,  and  general  information about the BBS.  Listed by  the  Y 
  100.         (sYstem information) command.
  101.  
  102.           MEETING.TXT  - Provides user with information as  to  scheduled 
  103.         user group meetings in the area.
  104.  
  105.           APPLYING.TXT - Listed by the [A]pply command. Gives information 
  106.         on what is required to increase user access level.
  107.  
  108.           MAINMENU.TXT - The BBS main menu.
  109.  
  110.           EDITMENU.TXT - The message editor option menu.
  111.  
  112.           READMENU.TXT - The read-messages option menu.
  113.  
  114.           FILEHLP.TXT  - The  files  system  command  help  file.   Gives 
  115.         information on how to use files system commands.
  116.  
  117.           FILEMENU.TXT - Files system command list.
  118.  
  119.           BULLETIN.TXT  - Bulletins  about system changes,  or any  other 
  120.         information of interest to users.
  121.  
  122.              All messages are stored in individual text files,  using the 
  123.         file  name MESSxxxx.TXT,  where xxxx is the message  number.  All 
  124.          .TXT files are expected on the default drive. They can be edited 
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.         Turbo BBS Version 1.05 - System Operator Notes - Page 3
  134.  
  135.  
  136.         using WordStar,  in the Document mode.  The BBS program is set up 
  137.         to ignore the WordStar "soft" carriage returns and line feeds, so 
  138.         the  word  wrap output driver of the BBS can format the  file  to 
  139.         suit  the user's terminal.
  140.  
  141.              Messages stored by the BBS editor can be in two formats: one 
  142.         contains  "hard"  carriage returns so special formatting used  in 
  143.         message entry is preserved (P subcommand in E command). The other 
  144.         contains  NO carriage returns,  which are inserted by the  output 
  145.         routine as needed. Editing a message created by the latter option 
  146.         with WordStar will show the entire message as a single  line:  ^B 
  147.         will  fix  this by inserting soft carriage returns which the  BBS 
  148.         will ignore.
  149.  
  150.              The  top of the include file MAILSYS.INC defines a  constant 
  151.         called  "maxmess,"  which defines the maximum number of  messages 
  152.         that  can  be held at one time on the  system.  The  distribution 
  153.         version sets this at 52,  which corresponds to the maximum number 
  154.         of  files available on a Kaypro 2 disk (64) minus the  number  of 
  155.         support  files on the default drive.  This limit can be increased 
  156.         if a larger directory is available, but remember that the message 
  157.         table is buffered in RAM and so each message uses 43 bytes.
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.         Turbo BBS Version 1.05 - System Operator Notes - Page 4
  200.  
  201.  
  202.         3 - Installing the BBS on your system
  203.  
  204.              The machine specific codes is contained in the include  file 
  205.         MACHDEP.INC.  All  system  serial  I/O is  routed  through  these 
  206.         routines.  The  distribution version was written for a Rixon 212A 
  207.         Intelligent Modem.
  208.  
  209.              To properly install the BBS,  it is necessary to know how to 
  210.         properly  program  and  control  the  serial  port.   Since  most 
  211.         operating  system drivers to not allow access to reading the  CTS 
  212.         (Clear To Send) line, this is necessary... It is unreasonable for 
  213.         the BBS to be expected to capture and comprehend the "NO CARRIER" 
  214.         or equivalent string from a smart modem.  In particular, you must 
  215.         know how to read the CTS line,  control the RTS line,  detect the 
  216.         input buffer full signal, and the output buffer empty line. Also, 
  217.         remember  the  character  data send and  character  data  receive 
  218.         functions!  To allow XMODEM transfers,  it is necessary to set up 
  219.         for 8 bits, no parity, and one stop bit.
  220.  
  221.              Since  the system expects to use the CTS line as  a  carrier 
  222.         detect  line,  it will be necessary to ensure that the modem does 
  223.         send  a  suitably readable signal for  this  purpose.  The  Rixon 
  224.         initialization  string does this.  On Hayes Smartmodems,  this is 
  225.         controlled by a switch that must be set so the CTS line  reflects 
  226.         an  on-line  status.  The  DSR or DCD  lines,  if  available  and 
  227.         satisfactory,  can  be  used:  just  read that line  in  the  cts 
  228.         function  in  MACHDEP.INC.
  229.  
  230.              The  modem should also disconnect when the system lowers the 
  231.         DTR   (Data  Terminal  Ready  - RS-232  pin  20)  line  for   400 
  232.         milliseconds.  If this feature is not available, another reliable 
  233.         disconnect method must be found and implemented in the  procedure 
  234.         hangup in MACHDEP.INC.  The DTR line is also lowered when the BBS 
  235.         has  been  accessed locally to inhibit  the  modem's  auto-answer 
  236.         function.  The  procedures setlocal and clearlocal (IO.INC)  will 
  237.         require editing if this feature is not supported by your modem.
  238.  
  239.              If  your system has a real-time clock,  the routines in  the 
  240.         include  file MACHDEP.INC must be adapted to use it.  Once again, 
  241.         the distribution file uses the Kaypro 4-84 clock. The Kaypro 2-84 
  242.         normally omits this, but the CPU board has the necessary hardware 
  243.         to implement it with the addition of a few parts.  If the  system 
  244.         lacks a real-time clock, the clock-related features can be turned 
  245.         off  by setting the constant "clockin" to FALSE at the  beginning 
  246.         of  the BBS.PAS file.  If you have no clock,  DO NOT  attempt  to 
  247.         remove  the clock support code from MACHDEP.INC or IO.INC!  While 
  248.         the routines won't be used, they must be present for compiling.
  249.  
  250.              If the special interest sections feature is not wanted,  set 
  251.         the "sectsin" constant at the beginning of BBS.PAS to FALSE.  The 
  252.         Section names are defined at the beginning of MAILSYS.INC. Future 
  253.         updates of the Turbo BBS will offer either password protection or 
  254.         individual  user  access  flags for  protected  sections.  It  is 
  255.         possible to not use sections in the BBS at first,  then implement 
  256.         them  later,  since  all files and messages in a  system  without 
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.         Turbo BBS Version 1.05 - System Operator Notes - Page 5
  266.  
  267.  
  268.         sections are placed in section 1 (Default: General).
  269.  
  270.              The  BBS program must be compiled into a .COM file by  using 
  271.         the  Turbo  Pascal  "O" (Options) command:  it is  too  large  to 
  272.         effectively compile into memory.
  273.  
  274.              If  your  system  lacks sufficient memory  to  run  the  BBS 
  275.         program as distributed, it will be necessary to overlay the files 
  276.         system with the message entry editor. This is done by putting the 
  277.         word  "overlay"  immediately before the procedure declaration  of 
  278.         the  enter routine (near the end of MAILSYS.INC) and the  filesys 
  279.         routine  (the  file FILESYS.INC).  (In  addition,  the  procedure 
  280.         sysoponly  at the beginning of BBS2.INC can be made into  another 
  281.         overlay, which will save even more space.)
  282.  
  283.         That is, change          procedure enter;
  284.                      to          overlay procedure enter;
  285.  
  286.              and change          procedure filesys;
  287.                      to          overlay procedure filesys;
  288.  
  289.              and change          procedure sysoponly;
  290.                      to          overlay procedure sysoponly;
  291.  
  292.         For  this to work properly,  it is absolutely necessary to  avoid 
  293.         putting  any  new procedure/function declarations at the  end  of 
  294.         MAILSYS.INC,   the  beginning  of  FILESYS.INC,  or  between  {$I 
  295.         MAILSYS.INC} and {$I FILESYS.INC} in BBS.PAS!
  296.         (Note  that using overlays will create 1 more file on the default 
  297.         drive: adjust the maximum number of messages as required.)
  298.  
  299.              The  number  of files in the file system is limited  by  the 
  300.         fact  that  the  directory  table is  buffered  in  RAM.  In  the 
  301.         distribution version,  a limit of 40 is set due to the fact  that 
  302.         the  Kaypro  2's disks have a mere 191K capacity (All  "freeware" 
  303.         contributions go to the Hard Disk fund). To expand the number, it 
  304.         is  necessary to change the filetab array declaration and  change 
  305.         the  number in the procedure newfile.  Future versions  will  set 
  306.         this  limit  with  a  compilation  constant.  Each  file  in  the 
  307.         directory  uses  39 bytes of memory.  Future versions will  allow 
  308.         large  directory  files  to be read directly from  disk  (at  the 
  309.         expense  of operation speed).  (Please remember that the BBS  was 
  310.         NOT originally written for distribution!) The BBS puts all  files 
  311.         on the "B:" drive.  To change this,  you must change the constant 
  312.         "filedrive" in BBS.PAS from 'B:'.
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.         Turbo BBS Version 1.05 - System Operator Notes - Page 6
  332.  
  333.  
  334.         4 - Running the system
  335.  
  336.              Once  BBS.COM  has been compiled successfully,  it  must  be 
  337.         placed  on  the  correct drives with the library  of  .TXT  files 
  338.         listed previously in this document.  The first thing the  program 
  339.         should  do when run is initialize the modem.
  340.  
  341.              Usernames and passwords are always mapped to capitals by the 
  342.         BBS  to  avoid errors.  SYSOP's access level is set  to  level  5 
  343.         automatically on first sign-on. This allows master control access 
  344.         to the first person to use this name: BEWARE! To sign on locally, 
  345.         press  the  'ESC' key on the host keyboard when the "Waiting  for 
  346.         call..."  string appears.  You can then sign on and test out  the 
  347.         system.  The  first thing to do is make your  password  something 
  348.         VERY secure: the system supports certain features for Sysops that 
  349.         are best not made available to the general public.
  350.  
  351.              The BBS main program supports two commands not listed in the 
  352.         menus. They are "!" and "@". "!" is the printer switch: if a user 
  353.         with level 5 (Sysop) access uses this command,  system output  is 
  354.         also sent to the lst:  device,  until another "!" is entered. "@" 
  355.         is  the  sysoponly procedure containing the comments file  reader 
  356.         and  ID  access editor.  This routine prompts for  input  with  a 
  357.         single  question mark ("?").  There are three commands supported. 
  358.         The  first  command is "C",  which plays back the  system's  user 
  359.         comments  file.  After  the file is displayed,  a  "Kill  (Y/N)?" 
  360.         prompt appears, allowing the sysop to delete the file. The second 
  361.         sysoponly command is "L",  which is the access level editor:  the 
  362.         system will ask for a user name:  if it is in the userlist,  that 
  363.         user's  current access level will be displayed,  and you will  be 
  364.         prompted for a new user level (pressing only RETURN changes it to 
  365.         0).  The system will loop through the Name/Access prompts until a 
  366.         non-existent  user name is entered,  whereupon the command  ends. 
  367.         The last sysoponly command is "!",  which is identical to the "!" 
  368.         printer switch in the main menu.
  369.  
  370.              Several commands contain Sysop extensions:  the L (call Log) 
  371.         command  gives  a "Kill (Y/N)?" prompt to level 5  users.  The  U 
  372.         (User  list)  command shows the access level of  each  user.  The 
  373.         R  (message  Read) function prompts "Delete  (Y/N)?"  after  each 
  374.         message read. Furthermore, all messages are visible to the Sysop.
  375.  
  376.              The  file  system  also contains extensions for  the  Sysop. 
  377.         These are the I,  E and K commands.  I is used to Install a  file 
  378.         that  is on the files disk but not in the BBS directory,  so  the 
  379.         Sysop  can  "upload"  files by just copying them onto  the  Files 
  380.         disk.  E edits a file's header,  allowing the sysop to rename the 
  381.         file,  change  the  name in the  contributor  field,  change  the 
  382.         section in which the file is stored,  and to release a file. When 
  383.         a  file  is released,  the public flag in the  directory  becomes 
  384.         "true".  All uploaded/installed files are initially private,  and 
  385.         do  not  appear  on the BBS directory to anyone without  level  5 
  386.         access.  Level  3 users have the ability to access private  files 
  387.         provided  they know the file name.  Any files on the  files  disk 
  388.         that  are not in the BBS directory are totally unaccessable,  but 
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.         Turbo BBS Version 1.05 - System Operator Notes - Page 7
  398.  
  399.  
  400.         cannot  be  overwritten.  The K command deletes a file  from  the 
  401.         directory table, and erases the file.
  402.  
  403.              The top of the FILESYS.INC file contains a number of options 
  404.         that  should be set up to match your system,  such as  the  files 
  405.         drive  capacity and the minimum increment of file size in Kbytes. 
  406.         If  your  system can store in increments of less than  1K  bytes, 
  407.         then set the increment to 1K:  this will allow a nearly full disk 
  408.         to  have  a  negative amount of  disk  space  remaining,  but  is 
  409.         otherwise harmless.
  410.  
  411.              The  program  is  made  to act as a private  BBS  simply  by 
  412.         setting the constant "openBBS" in BBS.PAS to false.  This has the 
  413.         effect  of hanging up on any REMOTE user who attempts to sign  on 
  414.         without  supplying a registered username within  three  attempts. 
  415.         New  users  must be signed on locally first,  before their  names 
  416.         will be permitted for remote access.
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.         Turbo BBS Version 1.05 - System Operator Notes - Page 8
  464.  
  465.  
  466.         5 - General Information
  467.  
  468.              This  software and its associated documentation and  support 
  469.         files are released to the public domain by the author.  It is not 
  470.         to  be  distributed  commercially or re-sold for  profit  without 
  471.         prior  permission from the author.  If you feel the  software  is 
  472.         well-suited  to your purposes,  and would like to be informed  of 
  473.         any updates or new versions, please send $30 to:
  474.  
  475.                        Robert H. Maxwell,
  476.                        201-2275 West 7th Avenue,
  477.                        Vancouver, B.C.  CANADA
  478.                        V6K 1Y3
  479.  
  480.         This contribution entitles you to support,  error correction, and 
  481.         updates.  Customization  of the code for specific purposes is not 
  482.         included,  but can be made available at extra cost.  It would  be 
  483.         appreciated if the specifics of the system you plan to run (phone 
  484.         number,  hours,  baud  rates,  etc.) were also included,  so  any 
  485.         improvements  YOU  make can be observed and possibly included  in 
  486.         updates.  Also,  a  compilation of systems using this BBS will be 
  487.         maintained on the Vancouver Turbo BBS from this information.
  488.  
  489.              The  original Turbo BBS is on-line in Vancouver 24  hours  a 
  490.         day  at  300 or 1200 baud at (604) 738-7811.  If the BBS  is  not 
  491.         available,  another  computer  is usually on-line to  report  the 
  492.         reason for the unavailability and when the BBS will  return.
  493.  
  494.              For  fastest  response  to  questions  or  problems,  it  is 
  495.         recommended  you  use  the  Vancouver  BBS.  Slower  response  is 
  496.         available  through CompuServe's Borland SIG,  where the  author's 
  497.         PPN is 70206,174. The use of voice calls is not appreciated until 
  498.         the details have been arranged.
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.